<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>ESP8266_RTOS_SDK: include/espressif/upgrade.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">ESP8266_RTOS_SDK
   &#160;<span id="projectnumber">v1.4.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_cf4dbf1328d2cf10d3f3933741525dc7.html">espressif</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">upgrade.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * ESPRSSIF MIT License</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * Copyright (c) 2015 &lt;ESPRESSIF SYSTEMS (SHANGHAI) PTE LTD&gt;</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted for use on ESPRESSIF SYSTEMS ESP8266 only, in which case,</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * it is free of charge, to any person obtaining a copy of this software and associated</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the Software is furnished</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * to do so, subject to the following conditions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all copies or</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * substantial portions of the Software.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef __UPGRADE_H__</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define __UPGRADE_H__</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="preprocessor">#include &quot;lwip/sockets.h&quot;</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga518257817c69fec25290c1bebad544b0">   50</a></span>&#160;<span class="preprocessor">#define SPI_FLASH_SEC_SIZE  4096    </span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga72e5aaa69793c72dc40998cb4b76168c">   52</a></span>&#160;<span class="preprocessor">#define USER_BIN1           0x00    </span></div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga7c4188e60c7cc5293d25dfb3b34dd224">   53</a></span>&#160;<span class="preprocessor">#define USER_BIN2           0x01    </span></div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#gae9af3da1e7d88b1e0f353d45059f6f1b">   55</a></span>&#160;<span class="preprocessor">#define UPGRADE_FLAG_IDLE   0x00    </span></div>
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#gaa45c4c3f3b5ed0d3070af7cf0fe151a9">   56</a></span>&#160;<span class="preprocessor">#define UPGRADE_FLAG_START  0x01    </span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga568d84b95c752e811a27a337830c3a54">   57</a></span>&#160;<span class="preprocessor">#define UPGRADE_FLAG_FINISH 0x02    </span></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga3b1051980757f4b853a8e436397e0fa6">   59</a></span>&#160;<span class="preprocessor">#define UPGRADE_FW_BIN1     0x00    </span></div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga9c5730b00a161df609340303bd6b4647">   60</a></span>&#160;<span class="preprocessor">#define UPGRADE_FW_BIN2     0x01    </span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="group__Upgrade__APIs.html#ga2897893fe6b22f7cd3159e57370dee7d">   69</a></span>&#160;<span class="preprocessor">typedef void (*upgrade_states_check_callback)(void *arg);</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment">//#define UPGRADE_SSL_ENABLE</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;</div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html">   73</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structupgrade__server__info.html">upgrade_server_info</a> {</div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#aff5a0f0a52dbedb0aa98a1cc408ba7df">   74</a></span>&#160;    <span class="keyword">struct </span>sockaddr_in <a class="code" href="structupgrade__server__info.html#aff5a0f0a52dbedb0aa98a1cc408ba7df">sockaddrin</a>;          </div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#a60f52082196cd22a78142fd14eef594e">   75</a></span>&#160;    <a class="code" href="group__Upgrade__APIs.html#ga2897893fe6b22f7cd3159e57370dee7d">upgrade_states_check_callback</a> <a class="code" href="structupgrade__server__info.html#a60f52082196cd22a78142fd14eef594e">check_cb</a>; </div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#a9ca9a8d4a9ec737b8694bf3625c48e88">   76</a></span>&#160;    uint32 <a class="code" href="structupgrade__server__info.html#a9ca9a8d4a9ec737b8694bf3625c48e88">check_times</a>;                     </div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#ab7408cf1414fc2d3ebd4ced54962e2b8">   77</a></span>&#160;    uint8 <a class="code" href="structupgrade__server__info.html#ab7408cf1414fc2d3ebd4ced54962e2b8">pre_version</a>[16];                  </div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#a54bc0d4687b1f9b5f8671bd157abd94d">   78</a></span>&#160;    uint8 <a class="code" href="structupgrade__server__info.html#a54bc0d4687b1f9b5f8671bd157abd94d">upgrade_version</a>[16];              </div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#aa68fc9d50895a4a8df09b200ae030867">   79</a></span>&#160;    uint8 *<a class="code" href="structupgrade__server__info.html#aa68fc9d50895a4a8df09b200ae030867">url</a>;                             </div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keywordtype">void</span> *pclient_param;</div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="structupgrade__server__info.html#a983ad0843b8753df3491570b65a20348">   81</a></span>&#160;    uint8 <a class="code" href="structupgrade__server__info.html#a983ad0843b8753df3491570b65a20348">upgrade_flag</a>;                     </div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;};</div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;</div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Upgrade__APIs.html#ga9b7abd9fa4790f5807c20a24e5e9a51a">system_upgrade_init</a>();</div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;</div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__Upgrade__APIs.html#ga643d7df496074bba1c6d165a3b5c7296">system_upgrade_deinit</a>();</div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;</div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="group__Upgrade__APIs.html#ga738472f97b8dc72342cb3eb6b984d0bd">system_upgrade</a>(uint8 *data, uint32 len);</div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="preprocessor">#ifdef UPGRADE_SSL_ENABLE</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;</div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="keywordtype">bool</span> system_upgrade_start_ssl(<span class="keyword">struct</span> <a class="code" href="structupgrade__server__info.html">upgrade_server_info</a> *server);</div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="group__Upgrade__APIs.html#ga9575df7b73865f9a373637c1d7a3763f">system_upgrade_start</a>(<span class="keyword">struct</span> <a class="code" href="structupgrade__server__info.html">upgrade_server_info</a> *server);</div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;</div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;}</div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;</div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="structupgrade__server__info_html_a983ad0843b8753df3491570b65a20348"><div class="ttname"><a href="structupgrade__server__info.html#a983ad0843b8753df3491570b65a20348">upgrade_server_info::upgrade_flag</a></div><div class="ttdeci">uint8 upgrade_flag</div><div class="ttdef"><b>Definition:</b> upgrade.h:81</div></div>
<div class="ttc" id="structupgrade__server__info_html_a9ca9a8d4a9ec737b8694bf3625c48e88"><div class="ttname"><a href="structupgrade__server__info.html#a9ca9a8d4a9ec737b8694bf3625c48e88">upgrade_server_info::check_times</a></div><div class="ttdeci">uint32 check_times</div><div class="ttdef"><b>Definition:</b> upgrade.h:76</div></div>
<div class="ttc" id="structupgrade__server__info_html_a60f52082196cd22a78142fd14eef594e"><div class="ttname"><a href="structupgrade__server__info.html#a60f52082196cd22a78142fd14eef594e">upgrade_server_info::check_cb</a></div><div class="ttdeci">upgrade_states_check_callback check_cb</div><div class="ttdef"><b>Definition:</b> upgrade.h:75</div></div>
<div class="ttc" id="structupgrade__server__info_html_ab7408cf1414fc2d3ebd4ced54962e2b8"><div class="ttname"><a href="structupgrade__server__info.html#ab7408cf1414fc2d3ebd4ced54962e2b8">upgrade_server_info::pre_version</a></div><div class="ttdeci">uint8 pre_version[16]</div><div class="ttdef"><b>Definition:</b> upgrade.h:77</div></div>
<div class="ttc" id="group__Upgrade__APIs_html_ga9b7abd9fa4790f5807c20a24e5e9a51a"><div class="ttname"><a href="group__Upgrade__APIs.html#ga9b7abd9fa4790f5807c20a24e5e9a51a">system_upgrade_init</a></div><div class="ttdeci">void system_upgrade_init()</div><div class="ttdoc">Upgrade function initialization. </div></div>
<div class="ttc" id="structupgrade__server__info_html"><div class="ttname"><a href="structupgrade__server__info.html">upgrade_server_info</a></div><div class="ttdef"><b>Definition:</b> upgrade.h:73</div></div>
<div class="ttc" id="structupgrade__server__info_html_a54bc0d4687b1f9b5f8671bd157abd94d"><div class="ttname"><a href="structupgrade__server__info.html#a54bc0d4687b1f9b5f8671bd157abd94d">upgrade_server_info::upgrade_version</a></div><div class="ttdeci">uint8 upgrade_version[16]</div><div class="ttdef"><b>Definition:</b> upgrade.h:78</div></div>
<div class="ttc" id="group__Upgrade__APIs_html_ga9575df7b73865f9a373637c1d7a3763f"><div class="ttname"><a href="group__Upgrade__APIs.html#ga9575df7b73865f9a373637c1d7a3763f">system_upgrade_start</a></div><div class="ttdeci">bool system_upgrade_start(struct upgrade_server_info *server)</div><div class="ttdoc">Start upgrade firmware through WiFi with normal connection. </div></div>
<div class="ttc" id="structupgrade__server__info_html_aff5a0f0a52dbedb0aa98a1cc408ba7df"><div class="ttname"><a href="structupgrade__server__info.html#aff5a0f0a52dbedb0aa98a1cc408ba7df">upgrade_server_info::sockaddrin</a></div><div class="ttdeci">struct sockaddr_in sockaddrin</div><div class="ttdef"><b>Definition:</b> upgrade.h:74</div></div>
<div class="ttc" id="structupgrade__server__info_html_aa68fc9d50895a4a8df09b200ae030867"><div class="ttname"><a href="structupgrade__server__info.html#aa68fc9d50895a4a8df09b200ae030867">upgrade_server_info::url</a></div><div class="ttdeci">uint8 * url</div><div class="ttdef"><b>Definition:</b> upgrade.h:79</div></div>
<div class="ttc" id="group__Upgrade__APIs_html_ga738472f97b8dc72342cb3eb6b984d0bd"><div class="ttname"><a href="group__Upgrade__APIs.html#ga738472f97b8dc72342cb3eb6b984d0bd">system_upgrade</a></div><div class="ttdeci">bool system_upgrade(uint8 *data, uint32 len)</div><div class="ttdoc">Upgrade function de-initialization. </div></div>
<div class="ttc" id="group__Upgrade__APIs_html_ga643d7df496074bba1c6d165a3b5c7296"><div class="ttname"><a href="group__Upgrade__APIs.html#ga643d7df496074bba1c6d165a3b5c7296">system_upgrade_deinit</a></div><div class="ttdeci">void system_upgrade_deinit()</div><div class="ttdoc">Upgrade function de-initialization. </div></div>
<div class="ttc" id="group__Upgrade__APIs_html_ga2897893fe6b22f7cd3159e57370dee7d"><div class="ttname"><a href="group__Upgrade__APIs.html#ga2897893fe6b22f7cd3159e57370dee7d">upgrade_states_check_callback</a></div><div class="ttdeci">void(* upgrade_states_check_callback)(void *arg)</div><div class="ttdoc">Callback of upgrading firmware through WiFi. </div><div class="ttdef"><b>Definition:</b> upgrade.h:69</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Mar 1 2016 10:19:26 for ESP8266_RTOS_SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
